home *** CD-ROM | disk | FTP | other *** search
/ CD Exchange / CD Exchange - Volume 1.iso / graphics / utils / hamlabplus_demo / documentation / userman.doc < prev    next >
Text File  |  1992-08-09  |  39KB  |  1,046 lines
  1. HAMLAB PLUS 2.0.8
  2. USER'S MANUAL
  3.  
  4. (c) Copyright 1990-1992 J. E. Hanway
  5. All rights reserved.
  6.  
  7. IN THIS DOCUMENT:
  8.  
  9. SETUP
  10.         SYSTEM REQUIREMENTS
  11.         INSTALLATION
  12.         CONFIGURATION
  13.         ADDING NEW FILTERS AND EXPORTERS
  14.  
  15. QUICK START
  16.  
  17. USER INTERFACE REFERENCE
  18.         COMMAND LINE OPTIONS
  19.         ENVIRONMENT VARIABLE
  20.         WORKBENCH TOOLTYPES
  21.         THE MAIN WINDOW
  22.         THE ABOUT WINDOW
  23.         THE CONFIGURATION WINDOW
  24.         THE COLOR CONTROL WINDOW
  25.         THE OUTPUT MODE WINDOW
  26.         THE AREXX CONSOLE
  27.         AREXX FUNCTION KEYS
  28.  
  29. THE HAMLAB PLUS PIPELINE AND CACHES
  30.  
  31.  
  32. SETUP
  33.  
  34. SYSTEM REQUIREMENTS
  35.  
  36. HAMLAB PLUS runs on any Amiga, under either release 1.3 or 2.0 of the
  37. Amiga operating system.  At least 1 meg of RAM is required.
  38.  
  39. For full functionality, HAMLAB PLUS requires EITHER
  40.  
  41.         AmigaOS Release 2
  42. OR
  43.         AmigaOS 1.3 and the ARP library.
  44.  
  45. If you have neither the ARP library nor Release 2, you can still run
  46. HAMLAB PLUS, with two limitations:
  47.  
  48.         It will only have a poor excuse for a file requester.
  49.  
  50.         HAMLAB 1.x input filters cannot be used.
  51.  
  52. In any case, only the ARP library itself (LIBS:arp.library) is
  53. used.  The ARP commands in C: do not need to be installed.  ARP
  54. is not required for operation under AmigaOS Release 2.
  55.  
  56. In order to use HAMLAB 1.x input filters, HAMLAB PLUS requires the
  57. AmigaDOS PIPE: device.  Different versions of PIPE: are supplied with
  58. 1.3 and 2.0.  If you encounter problems, check your DEVS:mountlist
  59. file to make sure that the correct version is used.  The 1.3 PIPE:
  60. entry should reference "l:pipe-handler" while the 2.0 entry should
  61. reference "l:queue-handler"
  62.  
  63. NOTE: You must have mathtrans.library in your LIBS: directory.
  64.  
  65. INSTALLATION
  66.  
  67. Installing a working copy of HAMLAB PLUS on your disk:
  68.  
  69. 1. Decide where you'd like to install HAMLAB PLUS, creating
  70.    a new drawer if necessary.
  71.  
  72. 2. Copy the following from the original HAMLAB PLUS disk to the drawer
  73.    that you chose in the last step. (Just drag icons in the Workbench,
  74.    or use the CLI.)
  75.  
  76.         The "HamLabPlus" program.
  77.  
  78.         The "HamLab.config" file. (*)
  79.  
  80.         The "Filters" drawer.   (This contains filters and exporters.)
  81.  
  82.         The "Curves" drawer.    (This contains color response curves.)
  83.  
  84.         (*) If you intend to run HAMLAB PLUS only from the Workbench,
  85.         just place the HamLab.config icon in the same drawer as the
  86.         program.  Otherwise, move it to either the S: or the DEVS:
  87.         directory.
  88.  
  89. 3. (optional) Copy the following, if you wish:
  90.  
  91.         The "Documentation" drawer.
  92.  
  93.         The "Rexx" drawer. (This contains example AREXX scripts.
  94.         To use them, they must be copied to the directory where
  95.         REXX: is assigned.)
  96.  
  97. 4. Run the HAMLAB PLUS copy you just made.  A "HamLab Config Problem"
  98.    requester may be displayed.  If so, just click the "Ok" button
  99.    until the main window appears.
  100.  
  101. 5. Click the "Configuration..." button to open the Config window.
  102.  
  103. 6. In the "Filter Path" line, enter the full path name of the
  104.    filters drawer.
  105.  
  106. 7. Drag the Config window to the upper left corner of the screen.
  107.    This will prevent it from opening every time you run the program.
  108.  
  109. 8. Click the "Save All" button.  This will display a file requester
  110.    with the name of your default config file filled in.  Confirm the
  111.    save.
  112.  
  113. 9. Close the main window to exit the program.
  114.  
  115. 10.Run HAMLAB PLUS again.  This time the "Config Problem" requester
  116.    should not appear.  If it does, double check the "Filter Path"
  117.    entry and make sure that the config file is being saved in the
  118.    correct directory.
  119.  
  120. Installing other files:
  121.  
  122. ARP library
  123.  
  124. The ARP library is not used if you are running AmigaOS Release 2.
  125.  
  126. If you are running AmigaOS 1.3 and don't have ARP, copy
  127. arp.library from the libs directory of the HAMLAB PLUS disk to
  128. the LIBS: directory of your boot disk.  If you obtained HAMLAB
  129. PLUS as a demo version from a source of freely distributable
  130. software, look there for ARP version 1.3.
  131.  
  132. PIPE: device
  133.  
  134. The PIPE: device is supplied as a standard part of both 1.3 and 2.0.
  135. So unless you've explicitly taken it out of your system, you already
  136. have it.  If you need to replace it, you'll have to go back to
  137. your original AmigaDOS disks to get the correct entry for
  138. DEVS:mountlist, plus the proper handler file for the L: directory.
  139. For 1.3, the handler is named "pipe-handler" and for 2.0 it is named
  140. "queue-handler".
  141.  
  142. Finally, somewhere in your s:startup-sequence or user-startup, you
  143. should have a "mount PIPE:" command.
  144.  
  145.  
  146. CONFIGURATION
  147.  
  148. When HAMLAB PLUS is run, it loads its configuration information from
  149. a "config file."  The config file is named "HamLab.config" and
  150. HAMLAB PLUS will look for it in the following places, in order:
  151.  
  152.         the current directory
  153.         S:
  154.         DEVS:
  155.  
  156. The config file contains the following types of information:
  157.  
  158.         Directory names where HAMLAB PLUS creates or looks for files
  159.         (filter programs and temporary files, for example)
  160.  
  161.         Information about filter and exporter programs that are
  162.         installed.
  163.  
  164.         Positions for all HAMLAB PLUS windows, and/or whether they
  165.         should open when the program is started.
  166.  
  167.         How much memory and/or disk space HAMLAB PLUS can use.
  168.  
  169.         Initial selections for all settings (resolution, size,
  170.         dithering, etc.).
  171.  
  172. When first installing HAMLAB PLUS, the most important things to get
  173. configured correctly are the filters.  Without them, HAMLAB PLUS
  174. is unable to read any images.  Once you have followed the installation
  175. instructions, the config file will be updated so that filters will be
  176. found in the correct directory and will be known to HAMLAB PLUS.
  177. Later, you'll probably want to tailor its memory and disk usage to
  178. your system.  See the section on caches for more information.
  179.  
  180. The config file is a text file that can be customized with a text
  181. editor, but editing it by hand isn't required.  The easiest way to
  182. create or update a config file is to run HAMLAB PLUS, set everything
  183. up the way you like it, and select either "Save" or "Save All" in the
  184. configuration window.
  185.  
  186. "Save" saves only settings that correspond to different types of
  187. images (resolution, dithering, etc.). For example, you may have one
  188. group of settings for hi-res images,  and another for low-res ones.
  189. "Save All" saves all settings (except cropping, which is always reset
  190. for each picture) and is suitable for creating or updating your master
  191. HamLab.config file.
  192.  
  193. Of course, you can create config files by hand that have any number of
  194. settings in them.  See the separate document "cmd-ref.doc" for more
  195. details on the config file format.
  196.  
  197. ADDING NEW FILTERS AND EXPORTERS
  198.  
  199. From time to time new filters and exports may be released for HAMLAB
  200. PLUS.  In order to use a new filter, you must first update the
  201. HamLab.config file so that HAMLAB PLUS knows about it.  Perform the
  202. following steps to do so:
  203.  
  204. 1. Copy the new filter to the HamLab filters directory. (If you
  205.    followed the standard installation, the filters directory should
  206.    be a drawer named "Filters")
  207.  
  208. 2. Run HAMLAB PLUS and bring up the Configuration window.
  209.  
  210. 3. Select "Scan Filters."  This will test every program in the
  211.    filters directory to see if it is a filter or exporter and, if
  212.    it is, what its characteristics are.
  213.  
  214. 4. When the scanning process completes, move the config window to
  215.    the upper left corner of the screen (to prevent its position
  216.    from being saved) and select "Save All."
  217.  
  218. QUICK START
  219.  
  220. HAMLAB PLUS can be started from the CLI or by double-clicking its
  221. Workbench icon.  The six large buttons at the bottom of the main
  222. window control the major functions of HAMLAB PLUS.
  223.  
  224. OPEN an image to begin working on it.  This will attempt to identify
  225. it, and read enough of it to determine its size.  Once opened, you can
  226. adjust HAMLAB PLUS's settings and execute one or more of the three
  227. main functions as follows.
  228.  
  229. EXPORT reads the image, converts it to 24 bits, crops, scales, and
  230. color corrects it, then saves it in a 24-bit format.  Hitting the
  231. EXPORT button displays a list of formats that can be exported.
  232.  
  233. DISPLAY reads the image, converts it to 24 bits, crops, scales, color
  234. corrects it, then reduces it